[JENKINS-68030] Optionally report most recent commit as changelog of a new build #1565

rhit-gawronja · 2024-03-20T14:06:59Z

JENKINS-68030 - Optionally report the most recent commit as the changelog of a new build

Looking to fix the behavior that is associated with push changes onto a brand new created branch. With these changes when the behavior is selected Jenkins will now present a changelog on the creation of a new branch. The changelog for the first build will be the most recent commit on the branch.

Other issue reports that are related and highlight the complexity of the general case include:

JENKINS-14138 - Please guess the initial changeset (an idea)
JENKINS-26354 - Please guess the initial changeset (another idea)

Git doesn't have the concept of a base branch. Many SCM providers (GitHub, Bitbucket, GitLab, Gitea, etc.) have a concept of a target branch, but the git plugin intentionally limits itself to the capabilities provided by command line git. Other plugins (like the GitHub branch source, Bitbucket branch source, GitLab branch source, and Gitea plugins) provide more capabilities and implement those capabilities using the specific APIs of the SCM provider.

Checklist

Types of changes

What types of changes does your code introduce?

New feature (non-breaking change which adds functionality)

New first build trait

UltimateGeek · 2024-03-20T18:44:10Z

Consider updating the references to "changelog" in documentation to "changeset" to match the keyword used in Jenkinsfiles.

src/main/java/jenkins/plugins/git/traits/FirstBuildChangelogTrait.java

UltimateGeek · 2024-03-20T19:56:22Z

src/main/java/hudson/plugins/git/GitSCM.java

+                    // this is the first time we are building this branch, so there's no base line
+                    // to compare against.
+                    // if we force the changelog, it'll contain all the changes in the repo, which
+                    // is not what we want.


I think this existing comment should be rewritten now that its within the context of the else case of the new option. But, perhaps just removing it would be best.

Removed in 61bb758

src/main/java/jenkins/plugins/git/traits/FirstBuildChangelogTrait.java

Co-authored-by: UltimateGeek <[email protected]>

@param

Removed improper CloudBees copyright documentation, updated @param for the constructor

rhit-gawronja · 2024-04-02T01:38:51Z

I have seen this issue in other pull requests (#1556 (comment)) I was wondering if anyone had other insight into this issue of not passing the windows tests?

Use line termination that is consistent with the other files in the repository. Use import ordering as defined by spotless.

src/main/java/hudson/plugins/git/extensions/impl/FirstBuildChangelog.java

src/main/resources/hudson/plugins/git/extensions/impl/FirstBuildChangelog/config.groovy

src/test/java/hudson/plugins/git/GitSCMTest.java

src/main/java/hudson/plugins/git/extensions/impl/FirstBuildChangelog.java

MarkEWaite · 2024-04-02T02:27:41Z

Needs documentation added to the README that describes how this is used in a Pipeline and how it is displayed to the user when they use the Pipeline snippet syntax generator inside their Jenkins controller.

I created a Pipeline with the Pipeline snippet syntax generator like this:

pipeline {
    agent any
    stages {
        stage('Checkout') {
            steps {
                checkout scmGit(branches: [[name: 'master']], 
                                extensions: [firstBuildChangelog(makeChangelog: true)], 
                                userRemoteConfigs: [[url: 'https://github.com/jenkinsci/git-plugin.git']])
            }
        }
    }
}

The new extension reports the most recent commit as the changelog. It does not report the changes from a base branch, because there is no reliable method to identify the base branch from command line git. Also adjusts capitalization to be consistent with other parts of the documentation.

MarkEWaite · 2024-05-01T18:15:24Z

Hi @MarkEWaite, do you think the open items in the checklist in this PR can be checked off, and this merged?

Thanks for asking.

I needed to make several changes to prepare for a final code review and interactive testing.

reverted the massive changes that were injected by spotless in 5dfe120 . This repository is not yet ready for spotless to be run on all its source files. There are too many pending pull requests that would be disrupted by that large change.
corrected the documentation to match the implemented behavior
switched the help file from DOS line endings to Unix line endings

Interactive tests are needed to confirm there are no surprises that automation has missed.

UltimateGeek · 2024-05-04T15:04:49Z

I needed to make several changes to prepare for a final code review and interactive testing.

Thanks @MarkEWaite . I see the checklist item for the online help updates is still outstanding. Are there any changes with it you'd like @rhit-gawronja or @rhit-inskeeda to make?

MarkEWaite · 2024-05-04T15:32:10Z

Thanks @MarkEWaite . I see the checklist item for the online help updates is still outstanding. Are there any changes with it you'd like @rhit-gawronja or @rhit-inskeeda to make?

I've completed the changes in the online help and in the documentation. I don't see any further changes that are needed.

UltimateGeek · 2024-06-02T13:30:55Z

Hi @MarkEWaite , do you have an estimate on when this will be ready to merge?

MarkEWaite · 2024-06-05T03:36:39Z

Hi @MarkEWaite , do you have an estimate on when this will be ready to merge?

I do not. I'm deeply involved in the Spring Security 6.x upgrade and in the preparations for the transition to require Java 17. A release will probably be needed as part of that, but I don't have a timeline for that next release.

MarkEWaite

Ready to merge.

Incremental that includes: * Use poll env when checking for ls-remote branches jenkinsci/git-plugin#1511 * Optionally report the most recent commit as the changelog of a new build jenkinsci/git-plugin#1565 https://issues.jenkins.io/browse/JENKINS-4162 https://issues.jenkins.io/browse/JENKINS-14138 https://issues.jenkins.io/browse/JENKINS-26354 https://issues.jenkins.io/browse/JENKINS-68030 * Generate and revoke access tokens with standard UI components jenkinsci/git-plugin#1597 * Do not assume HttpResponse is a functional interface jenkinsci/git-plugin#1590

rhit-inskeeda and others added 7 commits March 19, 2024 23:43

Add files via upload

3e62161

code for gui

838cc41

trait file

d76a507

gitscm changes

5f681b3

testing for new trait behavior

756f77c

Merge pull request #1 from rhit-inskeeda/new-trait

b5ba0e8

New first build trait

null check time

d6f6cf9

rhit-gawronja requested a review from a team as a code owner March 20, 2024 14:06

github-actions bot added documentation Improvements or additions to documentation tests Automated test addition or improvement labels Mar 20, 2024

rhit-gawronja changed the title ~~Integration~~ Implementing behavoir to handle JENKINS-4162 Mar 20, 2024

UltimateGeek reviewed Mar 20, 2024

View reviewed changes

src/main/java/jenkins/plugins/git/traits/FirstBuildChangelogTrait.java Outdated Show resolved Hide resolved

UltimateGeek reviewed Mar 20, 2024

View reviewed changes

src/main/java/jenkins/plugins/git/traits/FirstBuildChangelogTrait.java Outdated Show resolved Hide resolved

rhit-inskeeda and others added 2 commits March 22, 2024 12:12

update to proper version number

27d5942

Co-authored-by: UltimateGeek <[email protected]>

Update FirstBuildChangelogTrait

ce2fd99

Removed improper CloudBees copyright documentation, updated @param for the constructor

MarkEWaite added 3 commits April 1, 2024 19:54

Merge branch 'master' into integration

d17fafd

Format new files with spotless:apply

370d763

Use line termination that is consistent with the other files in the repository. Use import ordering as defined by spotless.

Remove trailing space characters

c66d139

MarkEWaite requested changes Apr 2, 2024

View reviewed changes

MarkEWaite changed the title ~~Implementing behavoir to handle JENKINS-4162~~ Allow Pipelines to report the most recent commit as the changelog of a new branch Apr 2, 2024

MarkEWaite changed the title ~~Allow Pipelines to report the most recent commit as the changelog of a new branch~~ Optionally report the most recent commit as the changelog of a new branch in a Pipeline Apr 2, 2024

MarkEWaite reviewed Apr 2, 2024

View reviewed changes

src/main/java/hudson/plugins/git/extensions/impl/FirstBuildChangelog.java Show resolved Hide resolved

MarkEWaite changed the title ~~Optionally report the most recent commit as the changelog of a new branch in a Pipeline~~ [JENKINS-4162] Optionally report the most recent commit as the changelog of a new branch in a Pipeline Apr 2, 2024

rhit-gawronja added 3 commits April 1, 2024 22:36

Changed equals to use proper equals method

88640c5

Changed equals to use proper equals method

62aad20

Changed equals to use proper equals method

cab31cc

MarkEWaite added 7 commits May 1, 2024 11:36

Undo spotless changes - not ready for spotless

45e7fff

Reduce doc diffs

4499e95

Merge branch 'master' into integration

591d0da

Use Unix file format for help

8df79db

Jenkins Pipeline symbols start with a lower case letter

667a4fa

Remove blank line from doc example

11955ee

MarkEWaite added 2 commits May 4, 2024 09:21

Format new example same as prior examples.

13816f4

Clarify first build option help and docs

81606a6

MarkEWaite removed dependencies Dependency related change documentation Improvements or additions to documentation tests Automated test addition or improvement labels May 6, 2024

MarkEWaite changed the title ~~[JENKINS-4162] Optionally report the most recent commit as the changelog of a new branch in a Pipeline~~ [JENKINS-4162] Optionally report the most recent commit as the changelog of a new build May 6, 2024

MarkEWaite added 2 commits July 28, 2024 18:12

Merge branch 'master' into integration

b449318

Remove comment as suggested by reviewer

61bb758

github-actions bot added documentation Improvements or additions to documentation tests Automated test addition or improvement labels Jul 29, 2024

MarkEWaite enabled auto-merge (squash) July 29, 2024 00:20

MarkEWaite removed documentation Improvements or additions to documentation tests Automated test addition or improvement labels Jul 29, 2024

MarkEWaite approved these changes Jul 29, 2024

View reviewed changes

MarkEWaite merged commit 25ca71b into jenkinsci:master Jul 29, 2024
17 checks passed

MarkEWaite changed the title ~~[JENKINS-4162] Optionally report the most recent commit as the changelog of a new build~~ [JENKINS-14138] Optionally report the most recent commit as the changelog of a new build Jul 29, 2024

MarkEWaite changed the title ~~[JENKINS-14138] Optionally report the most recent commit as the changelog of a new build~~ [JENKINS-68030] Optionally report most recent commit as changelog of a new build Jul 29, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[JENKINS-68030] Optionally report most recent commit as changelog of a new build #1565

[JENKINS-68030] Optionally report most recent commit as changelog of a new build #1565

rhit-gawronja commented Mar 20, 2024 •

edited by MarkEWaite

Loading

UltimateGeek commented Mar 20, 2024

UltimateGeek Mar 20, 2024 •

edited

Loading

MarkEWaite Jul 29, 2024

rhit-gawronja commented Apr 2, 2024

MarkEWaite commented Apr 2, 2024 •

edited

Loading

MarkEWaite commented May 1, 2024

UltimateGeek commented May 4, 2024

MarkEWaite commented May 4, 2024

UltimateGeek commented Jun 2, 2024

MarkEWaite commented Jun 5, 2024

MarkEWaite left a comment

[JENKINS-68030] Optionally report most recent commit as changelog of a new build #1565

[JENKINS-68030] Optionally report most recent commit as changelog of a new build #1565

Conversation

rhit-gawronja commented Mar 20, 2024 • edited by MarkEWaite Loading

JENKINS-68030 - Optionally report the most recent commit as the changelog of a new build

Checklist

Types of changes

UltimateGeek commented Mar 20, 2024

UltimateGeek Mar 20, 2024 • edited Loading

Choose a reason for hiding this comment

MarkEWaite Jul 29, 2024

Choose a reason for hiding this comment

rhit-gawronja commented Apr 2, 2024

MarkEWaite commented Apr 2, 2024 • edited Loading

MarkEWaite commented May 1, 2024

UltimateGeek commented May 4, 2024

MarkEWaite commented May 4, 2024

UltimateGeek commented Jun 2, 2024

MarkEWaite commented Jun 5, 2024

MarkEWaite left a comment

Choose a reason for hiding this comment

rhit-gawronja commented Mar 20, 2024 •

edited by MarkEWaite

Loading

UltimateGeek Mar 20, 2024 •

edited

Loading

MarkEWaite commented Apr 2, 2024 •

edited

Loading